ECSのサービスディスカバリーをCloudFormationで作成する

ECSでサービスディスカバリー（サービス検出）を利用したい場合に、CloudFormationでリソースを作成する方法をまとめました。

#AWS CloudFormation

#Amazon ECS

#AWS Fargate

#AWS Cloud Map

#AWS

とばち

2021.03.31

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

コンサル部のtobachi（@toda_kk）です。

サービスディスカバリー（サービス検出）を使うECSリソースをCloudFormationで作成する機会があり、意外とまとまった記事が見つからなかったのでテンプレートの例を記載してみました。

結論

必要なリソース

AWS::ServiceDiscovery::PrivateDnsNamespaceリソースを作成する。
AWS::ServiceDiscovery::Serviceのリソースを作成する。DnsConfig.NamespaceIdに1. で作成したリソースのIDを指定する。
サービスディスカバリーで名前解決したいAWS::ECS::Serviceリソースを作成する。ServiceRegistries.RegistryArnに2. で作成したリソースのARNを指定する。

サンプルテンプレート

サービスディスカバリーを動かすのに最低限必要なリソースのみを記述したサンプルテンプレートです。

ベタ書きしている箇所がいくつかあるので、適宜修正した上でご利用ください。

AWSTemplateFormatVersion: "2010-09-09"
Resources:
  PrivateDnsNamespace:
    Type: AWS::ServiceDiscovery::PrivateDnsNamespace
    Properties:
      Vpc: "sample-vpc"
      Name: "sample.local"

  ServiceDiscovery:
    Type: AWS::ServiceDiscovery::Service
    Properties:
      HealthCheckCustomConfig:
        FailureThreshold: 1
      DnsConfig:
        DnsRecords:
          - Type: A
            TTL: 60
        NamespaceId: !GetAtt PrivateDnsNamespace.Id
      Name: "service"

  ECSService:
    Type: "AWS::ECS::Service"
    Properties:
      ServiceName: "sample-ecs-service"
      Cluster: "sample-ecs-cluster"
      ServiceRegistries:
        - RegistryArn: !GetAtt ServiceDiscovery.Arn
      DesiredCount: 2
      LaunchType: "FARGATE"
      PlatformVersion: "1.4.0"
      TaskDefinition: "arn:aws:ecs:ap-northeast-1:123456789012:task-definition/sample-ecs-task:1"
      DeploymentConfiguration:
        MaximumPercent: 200
        MinimumHealthyPercent: 100
      NetworkConfiguration:
        AwsvpcConfiguration:
          AssignPublicIp: "DISABLED"
          SecurityGroups:
            - sg-xxxxxxxxxx
          Subnets:
            - subnet-xxxxxxxxxx
            - subnet-xxxxxxxxxx
      SchedulingStrategy: "REPLICA"